|
Eclipse JDT Pre-release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jdt.core.search.SearchParticipant
A search participant describes a particular extension to a generic search mechanism, permitting combined search actions which will involve all required participants. A search scope defines which participants are involved. A search participant is responsible for holding index files, and selecting the appropriate ones to feed to index queries. It also can map a document path to an actual document (note that documents could live outside the workspace or not exist yet, and thus aren't just resources).
Field Summary | |
static SearchParticipant[] |
NO_PARTICIPANT
|
Constructor Summary | |
SearchParticipant()
|
Method Summary | |
static void |
addIndexEntry(char[] category,
char[] key,
SearchDocument document,
String indexPath)
|
abstract void |
beginSearching()
Intermediate notification sent when a given participant is getting involved. |
abstract void |
doneSearching()
Intermediate notification sent when a given participant is finished to be involved. |
abstract String |
getDescription()
Returns a displayable name of this search participant. |
abstract SearchDocument |
getDocument(String documentPath)
Bind a document path to an actual document. |
abstract void |
indexDocument(SearchDocument document,
String indexPath)
Index the given document. |
abstract void |
locateMatches(SearchDocument[] indexMatches,
SearchPattern pattern,
IJavaSearchScope scope,
SearchRequestor requestor,
IProgressMonitor monitor)
Locate the matches in the given documents and report them using the search requestor. |
static void |
removeAllIndexEntries(String documentPath,
String indexPath)
|
void |
scheduleDocumentIndexing(SearchDocument document,
String containerPath,
String indexPath)
Schedules the indexing of the given document. |
abstract IPath[] |
selectIndexes(SearchPattern query,
IJavaSearchScope scope)
Returns the collection of index paths to consider when performing a given search query in a given scope. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final SearchParticipant[] NO_PARTICIPANT
Constructor Detail |
public SearchParticipant()
Method Detail |
public static void addIndexEntry(char[] category, char[] key, SearchDocument document, String indexPath)
public static void removeAllIndexEntries(String documentPath, String indexPath)
public abstract void beginSearching()
public abstract void doneSearching()
public abstract String getDescription()
public abstract SearchDocument getDocument(String documentPath)
public abstract void indexDocument(SearchDocument document, String indexPath)
public abstract void locateMatches(SearchDocument[] indexMatches, SearchPattern pattern, IJavaSearchScope scope, SearchRequestor requestor, IProgressMonitor monitor) throws CoreException
CoreException
public void scheduleDocumentIndexing(SearchDocument document, String containerPath, String indexPath)
public abstract IPath[] selectIndexes(SearchPattern query, IJavaSearchScope scope)
|
Eclipse JDT Pre-release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |